Telegram Bot/eu.vendeli.tgbot.types.internal

Package-level declarations

Types

Action

fun interface Action

ActivityCtx

data class ActivityCtx<out T : ProcessedUpdate>(val update: T)

BreakCondition

fun interface BreakCondition

BusinessConnectionUpdate

@Serializable(with = BusinessConnectionUpdate.Companion::class)

data class BusinessConnectionUpdate(val updateId: Int, val origin: Update, val businessConnection: BusinessConnection) : ProcessedUpdate, UserReference

BusinessMessageUpdate

@Serializable(with = BusinessMessageUpdate.Companion::class)

data class BusinessMessageUpdate(val updateId: Int, val origin: Update, val businessMessage: Message) : ProcessedUpdate, UserReference

CallbackQueryUpdate

@Serializable(with = CallbackQueryUpdate.Companion::class)

data class CallbackQueryUpdate(val updateId: Int, val origin: Update, val callbackQuery: CallbackQuery) : ProcessedUpdate, UserReference

ChainLink

abstract class ChainLink : Link<Unit>

ChannelPostUpdate

@Serializable(with = ChannelPostUpdate.Companion::class)

data class ChannelPostUpdate(val updateId: Int, val origin: Update, val channelPost: Message) : ProcessedUpdate, UserReference

ChatBoostUpdate

@Serializable(with = ChatBoostUpdate.Companion::class)

data class ChatBoostUpdate(val updateId: Int, val origin: Update, val chatBoost: ChatBoostUpdated) : ProcessedUpdate

ChatJoinRequestUpdate

@Serializable(with = ChatJoinRequestUpdate.Companion::class)

data class ChatJoinRequestUpdate(val updateId: Int, val origin: Update, val chatJoinRequest: ChatJoinRequest) : ProcessedUpdate, UserReference

ChatMemberUpdate

@Serializable(with = ChatMemberUpdate.Companion::class)

data class ChatMemberUpdate(val updateId: Int, val origin: Update, val chatMember: ChatMemberUpdated) : ProcessedUpdate, UserReference

ChosenInlineResultUpdate

@Serializable(with = ChosenInlineResultUpdate.Companion::class)

data class ChosenInlineResultUpdate(val updateId: Int, val origin: Update, val chosenInlineResult: ChosenInlineResult) : ProcessedUpdate, UserReference

CommandContext

data class CommandContext<out T : ProcessedUpdate>(val update: T, val parameters: Map<String, String>)

CommonMatcher

sealed class CommonMatcher

Currency

@Serializable

enum Currency : Enum<Currency>

DeletedBusinessMessagesUpdate

@Serializable(with = DeletedBusinessMessagesUpdate.Companion::class)

data class DeletedBusinessMessagesUpdate(val updateId: Int, val origin: Update, val deletedBusinessMessages: BusinessMessagesDeleted) : ProcessedUpdate

EditedBusinessMessageUpdate

@Serializable(with = EditedBusinessMessageUpdate.Companion::class)

data class EditedBusinessMessageUpdate(val updateId: Int, val origin: Update, val editedBusinessMessage: Message) : ProcessedUpdate, UserReference

EditedChannelPostUpdate

@Serializable(with = EditedChannelPostUpdate.Companion::class)

data class EditedChannelPostUpdate(val updateId: Int, val origin: Update, val editedChannelPost: Message) : ProcessedUpdate, UserReference

EditedMessageUpdate

@Serializable(with = EditedMessageUpdate.Companion::class)

data class EditedMessageUpdate(val updateId: Int, val origin: Update, val editedMessage: Message) : ProcessedUpdate, UserReference

ExceptionHandlingStrategy

sealed class ExceptionHandlingStrategy

Strategies to do with exceptions and updates that caused them.

FailedUpdate

data class FailedUpdate(val exception: Throwable, val update: ProcessedUpdate)

HttpLogLevel

enum HttpLogLevel : Enum<HttpLogLevel>

Proxy enum class for Ktor log leveling.

Identifier

@Serializable(with = Identifier.Serde::class)

sealed class Identifier

IdLong

interface IdLong

ImplicitFile

@Serializable(with = ImplicitFile.Companion::class)

sealed class ImplicitFile

InlineQueryUpdate

@Serializable(with = InlineQueryUpdate.Companion::class)

data class InlineQueryUpdate(val updateId: Int, val origin: Update, val inlineQuery: InlineQuery) : ProcessedUpdate, UserReference

InputBreakPoint

data class InputBreakPoint(val condition: ActivityCtx<ProcessedUpdate>.() -> Boolean, val activity: OnInputActivity? = null, val repeat: Boolean = true)

InputFile

@Serializable

data class InputFile(val data: ByteArray, val fileName: String = DEFAULT_FILENAME, val contentType: String = DEFAULT_CONTENT_TYPE)

InvocationMeta

data class InvocationMeta(val qualifier: String, val function: String, val rateLimits: RateLimits = RateLimits.NOT_LIMITED, val guard: KClass<out Guard> = DefaultGuard::class, val argParser: KClass<out ArgumentParser> = DefaultArgParser::class)

LogLvl

enum LogLvl : Enum<LogLvl>

Proxy enum for Bot logger leveling.

MessageReactionCountUpdate

@Serializable(with = MessageReactionCountUpdate.Companion::class)

data class MessageReactionCountUpdate(val updateId: Int, val origin: Update, val messageReactionCount: MessageReactionCountUpdated) : ProcessedUpdate

MessageReactionUpdate

@Serializable(with = MessageReactionUpdate.Companion::class)

data class MessageReactionUpdate(val updateId: Int, val origin: Update, val messageReaction: MessageReactionUpdated) : ProcessedUpdate, UserReference

MessageUpdate

@Serializable(with = MessageUpdate.Companion::class)

data class MessageUpdate(val updateId: Int, val origin: Update, val message: Message) : ProcessedUpdate, UserReference

MyChatMemberUpdate

@Serializable(with = MyChatMemberUpdate.Companion::class)

data class MyChatMemberUpdate(val updateId: Int, val origin: Update, val myChatMember: ChatMemberUpdated) : ProcessedUpdate, UserReference

PollAnswerUpdate

@Serializable(with = PollAnswerUpdate.Companion::class)

data class PollAnswerUpdate(val updateId: Int, val origin: Update, val pollAnswer: PollAnswer) : ProcessedUpdate, UserReference

PollUpdate

@Serializable(with = PollUpdate.Companion::class)

data class PollUpdate(val updateId: Int, val origin: Update, val poll: Poll) : ProcessedUpdate

PreCheckoutQueryUpdate

@Serializable(with = PreCheckoutQueryUpdate.Companion::class)

data class PreCheckoutQueryUpdate(val updateId: Int, val origin: Update, val preCheckoutQuery: PreCheckoutQuery) : ProcessedUpdate, UserReference

ProcessedUpdate

@Serializable(with = ProcessedUpdate.Companion::class)

sealed class ProcessedUpdate : TextReference, MultipleResponse

PurchasedPaidMediaUpdate

@Serializable(with = PurchasedPaidMediaUpdate.Companion::class)

data class PurchasedPaidMediaUpdate(val updateId: Int, val origin: Update, val purchasedPaidMedia: PaidMediaPurchased) : ProcessedUpdate, UserReference

RemovedChatBoostUpdate

@Serializable(with = RemovedChatBoostUpdate.Companion::class)

data class RemovedChatBoostUpdate(val updateId: Int, val origin: Update, val removedChatBoost: ChatBoostRemoved) : ProcessedUpdate

Response

@Serializable

sealed class Response<T>

ShippingQueryUpdate

@Serializable(with = ShippingQueryUpdate.Companion::class)

data class ShippingQueryUpdate(val updateId: Int, val origin: Update, val shippingQuery: ShippingQuery) : ProcessedUpdate, UserReference

TextReference

interface TextReference

UpdateType

@Serializable

enum UpdateType : Enum<UpdateType>

UserReference

interface UserReference

Properties

userOrNull

val ProcessedUpdate.userOrNull: User?

Functions

foldResponse

inline suspend fun <T, R> Deferred<Response<out T>>.foldResponse(success: Response.Success<T>.() -> R, failure: Response.Failure.() -> R): R

Handles response success and failure cases.

getOrNull

fun <T> Response<T>.getOrNull(): T?

Get response or null on failure.

inline suspend fun <T> Deferred<Response<out T>>.getOrNull(): T?

getUser

inline fun ProcessedUpdate.getUser(): User

isSuccess

fun <T> Response<T>.isSuccess(): Boolean

Whether the request completed successfully.

onFailure

inline fun <T> Response<T>.onFailure(block: (Response.Failure) -> Unit): T?

inline suspend fun <T> Deferred<Response<out T>>.onFailure(block: (Response.Failure) -> Unit): T?

Handles request's failure case.